API Documentation
Public Member Functions | List of all members
nkGraphics::ResourceTask Class Reference

A task made for loading resources. More...

Inheritance diagram for nkGraphics::ResourceTask:
nkTasks::Task

Public Member Functions

 ResourceTask ()
 
 ~ResourceTask ()
 
void setTaskType (RESOURCE_TASK_TYPE value)
 
void setDeclPath (const std::string_view &value)
 
void setLoadQuery (ResourceSetLoadQuery *value)
 
void setDefaultCompoName (const std::string_view &value)
 
void setCallback (ResourceSaveLoadCallback *value)
 
virtual nkTasks::TASK_RESULT onWork () override
 
virtual void onWorkDone () override
 
virtual void onSuccess () override
 
virtual void onFail () override
 
virtual void onAbort () override
 
- Public Member Functions inherited from nkTasks::Task
 Task ()
 
virtual ~Task ()
 
ThreadgetParentThread () const
 
TASK_RESULT getWorkResult () const
 
void setParentThread (Thread *thread)
 
void setWorkResult (TASK_RESULT result)
 

Detailed Description

A task made for loading resources.

This API is currently not meant to be used outside of the nkGraphics::ResourceManager. See the loading functions.

Constructor & Destructor Documentation

◆ ResourceTask()

nkGraphics::ResourceTask::ResourceTask ( )

Constructor.

◆ ~ResourceTask()

nkGraphics::ResourceTask::~ResourceTask ( )

Destructor.

Member Function Documentation

◆ setTaskType()

void nkGraphics::ResourceTask::setTaskType ( RESOURCE_TASK_TYPE  value)

WIP.

◆ setDeclPath()

void nkGraphics::ResourceTask::setDeclPath ( const std::string_view &  value)

WIP.

◆ setLoadQuery()

void nkGraphics::ResourceTask::setLoadQuery ( ResourceSetLoadQuery value)

WIP.

◆ setDefaultCompoName()

void nkGraphics::ResourceTask::setDefaultCompoName ( const std::string_view &  value)

WIP.

◆ setCallback()

void nkGraphics::ResourceTask::setCallback ( ResourceSaveLoadCallback value)

WIP.

◆ onWork()

virtual nkTasks::TASK_RESULT nkGraphics::ResourceTask::onWork ( )
overridevirtual

WIP.

Implements nkTasks::Task.

◆ onWorkDone()

virtual void nkGraphics::ResourceTask::onWorkDone ( )
overridevirtual

WIP.

Implements nkTasks::Task.

◆ onSuccess()

virtual void nkGraphics::ResourceTask::onSuccess ( )
overridevirtual

WIP.

Implements nkTasks::Task.

◆ onFail()

virtual void nkGraphics::ResourceTask::onFail ( )
overridevirtual

WIP.

Implements nkTasks::Task.

◆ onAbort()

virtual void nkGraphics::ResourceTask::onAbort ( )
overridevirtual

WIP.

Implements nkTasks::Task.


The documentation for this class was generated from the following file: